home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 July: Mac OS SDK / Dev.CD Jul 99 SDK1.toast / Development Kits / Mac OS / Interfaces&Libraries / Universal / Interfaces / CIncludes / Icons.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-08-17  |  44.0 KB  |  1,380 lines  |  [TEXT/MPS ]
  1. /*
  2.      File:        Icons.h
  3.  
  4.      Contains:    Icon Utilities and Icon Services Interfaces.
  5.  
  6.      Version:    Technology:    Mac OS 8
  7.                  Release:    Universal Interfaces 3.2
  8.  
  9.      Copyright:    © 1990-1998 by Apple Computer, Inc. All rights reserved
  10.  
  11.      Bugs?:        For bug reports, consult the following page on
  12.                  the World Wide Web:
  13.  
  14.                      http://developer.apple.com/bugreporter/
  15.  
  16. */
  17. #ifndef __ICONS__
  18. #define __ICONS__
  19.  
  20. #ifndef __MACTYPES__
  21. #include <MacTypes.h>
  22. #endif
  23. #ifndef __QUICKDRAW__
  24. #include <Quickdraw.h>
  25. #endif
  26. #ifndef __FILES__
  27. #include <Files.h>
  28. #endif
  29. #ifndef __CODEFRAGMENTS__
  30. #include <CodeFragments.h>
  31. #endif
  32.  
  33.  
  34.  
  35. #if PRAGMA_ONCE
  36. #pragma once
  37. #endif
  38.  
  39. #ifdef __cplusplus
  40. extern "C" {
  41. #endif
  42.  
  43. #if PRAGMA_IMPORT
  44. #pragma import on
  45. #endif
  46.  
  47. #if PRAGMA_STRUCT_ALIGN
  48.     #pragma options align=mac68k
  49. #elif PRAGMA_STRUCT_PACKPUSH
  50.     #pragma pack(push, 2)
  51. #elif PRAGMA_STRUCT_PACK
  52.     #pragma pack(2)
  53. #endif
  54.  
  55. /* The following are icons for which there are both icon suites and SICNs. */
  56. /* Avoid using icon resources if possible. Use IconServices instead. */
  57.  
  58. enum {
  59.     kGenericDocumentIconResource = -4000,
  60.     kGenericStationeryIconResource = -3985,
  61.     kGenericEditionFileIconResource = -3989,
  62.     kGenericApplicationIconResource = -3996,
  63.     kGenericDeskAccessoryIconResource = -3991,
  64.     kGenericFolderIconResource    = -3999,
  65.     kPrivateFolderIconResource    = -3994,
  66.     kFloppyIconResource            = -3998,
  67.     kTrashIconResource            = -3993,
  68.     kGenericRAMDiskIconResource    = -3988,
  69.     kGenericCDROMIconResource    = -3987
  70. };
  71.  
  72. /* The following are icons for which there are SICNs only. */
  73. /* Avoid using icon resources if possible. Use IconServices instead. */
  74.  
  75. enum {
  76.     kDesktopIconResource        = -3992,
  77.     kOpenFolderIconResource        = -3997,
  78.     kGenericHardDiskIconResource = -3995,
  79.     kGenericFileServerIconResource = -3972,
  80.     kGenericSuitcaseIconResource = -3970,
  81.     kGenericMoverObjectIconResource = -3969
  82. };
  83.  
  84. /* The following are icons for which there are icon suites only. */
  85. /* Avoid using icon resources if possible. Use IconServices instead. */
  86.  
  87. enum {
  88.     kGenericPreferencesIconResource = -3971,
  89.     kGenericQueryDocumentIconResource = -16506,
  90.     kGenericExtensionIconResource = -16415,
  91.     kSystemFolderIconResource    = -3983,
  92.     kHelpIconResource            = -20271,
  93.     kAppleMenuFolderIconResource = -3982
  94. };
  95.  
  96. /* Obsolete. Use named constants defined above. */
  97.  
  98. enum {
  99.     genericDocumentIconResource    = kGenericDocumentIconResource,
  100.     genericStationeryIconResource = kGenericStationeryIconResource,
  101.     genericEditionFileIconResource = kGenericEditionFileIconResource,
  102.     genericApplicationIconResource = kGenericApplicationIconResource,
  103.     genericDeskAccessoryIconResource = kGenericDeskAccessoryIconResource,
  104.     genericFolderIconResource    = kGenericFolderIconResource,
  105.     privateFolderIconResource    = kPrivateFolderIconResource,
  106.     floppyIconResource            = kFloppyIconResource,
  107.     trashIconResource            = kTrashIconResource,
  108.     genericRAMDiskIconResource    = kGenericRAMDiskIconResource,
  109.     genericCDROMIconResource    = kGenericCDROMIconResource,
  110.     desktopIconResource            = kDesktopIconResource,
  111.     openFolderIconResource        = kOpenFolderIconResource,
  112.     genericHardDiskIconResource    = kGenericHardDiskIconResource,
  113.     genericFileServerIconResource = kGenericFileServerIconResource,
  114.     genericSuitcaseIconResource    = kGenericSuitcaseIconResource,
  115.     genericMoverObjectIconResource = kGenericMoverObjectIconResource,
  116.     genericPreferencesIconResource = kGenericPreferencesIconResource,
  117.     genericQueryDocumentIconResource = kGenericQueryDocumentIconResource,
  118.     genericExtensionIconResource = kGenericExtensionIconResource,
  119.     systemFolderIconResource    = kSystemFolderIconResource,
  120.     appleMenuFolderIconResource    = kAppleMenuFolderIconResource
  121. };
  122.  
  123. /* Avoid using icon resources if possible. Use IconServices instead. */
  124.  
  125. enum {
  126.     kStartupFolderIconResource    = -3981,
  127.     kOwnedFolderIconResource    = -3980,
  128.     kDropFolderIconResource        = -3979,
  129.     kSharedFolderIconResource    = -3978,
  130.     kMountedFolderIconResource    = -3977,
  131.     kControlPanelFolderIconResource = -3976,
  132.     kPrintMonitorFolderIconResource = -3975,
  133.     kPreferencesFolderIconResource = -3974,
  134.     kExtensionsFolderIconResource = -3973,
  135.     kFontsFolderIconResource    = -3968,
  136.     kFullTrashIconResource        = -3984
  137. };
  138.  
  139. /* Obsolete. Use named constants defined above. */
  140.  
  141. enum {
  142.     startupFolderIconResource    = kStartupFolderIconResource,
  143.     ownedFolderIconResource        = kOwnedFolderIconResource,
  144.     dropFolderIconResource        = kDropFolderIconResource,
  145.     sharedFolderIconResource    = kSharedFolderIconResource,
  146.     mountedFolderIconResource    = kMountedFolderIconResource,
  147.     controlPanelFolderIconResource = kControlPanelFolderIconResource,
  148.     printMonitorFolderIconResource = kPrintMonitorFolderIconResource,
  149.     preferencesFolderIconResource = kPreferencesFolderIconResource,
  150.     extensionsFolderIconResource = kExtensionsFolderIconResource,
  151.     fontsFolderIconResource        = kFontsFolderIconResource,
  152.     fullTrashIconResource        = kFullTrashIconResource
  153. };
  154.  
  155.  
  156. enum {
  157.     kHuge1BitMask                = FOUR_CHAR_CODE('ich#'),
  158.     kHuge4BitData                = FOUR_CHAR_CODE('ich4'),
  159.     kHuge8BitData                = FOUR_CHAR_CODE('ich8'),
  160.     kHuge32BitData                = FOUR_CHAR_CODE('ih32'),
  161.     kHuge8BitMask                = FOUR_CHAR_CODE('h8mk'),
  162.     kLarge1BitMask                = FOUR_CHAR_CODE('ICN#'),
  163.     kLarge4BitData                = FOUR_CHAR_CODE('icl4'),
  164.     kLarge8BitData                = FOUR_CHAR_CODE('icl8'),
  165.     kLarge32BitData                = FOUR_CHAR_CODE('il32'),
  166.     kLarge8BitMask                = FOUR_CHAR_CODE('l8mk'),
  167.     kSmall1BitMask                = FOUR_CHAR_CODE('ics#'),
  168.     kSmall4BitData                = FOUR_CHAR_CODE('ics4'),
  169.     kSmall8BitData                = FOUR_CHAR_CODE('ics8'),
  170.     kSmall32BitData                = FOUR_CHAR_CODE('is32'),
  171.     kSmall8BitMask                = FOUR_CHAR_CODE('s8mk'),
  172.     kMini1BitMask                = FOUR_CHAR_CODE('icm#'),
  173.     kMini4BitData                = FOUR_CHAR_CODE('icm4'),
  174.     kMini8BitData                = FOUR_CHAR_CODE('icm8')
  175. };
  176.  
  177. /* Obsolete. Use names defined above. */
  178.  
  179. enum {
  180.     large1BitMask                = kLarge1BitMask,
  181.     large4BitData                = kLarge4BitData,
  182.     large8BitData                = kLarge8BitData,
  183.     small1BitMask                = kSmall1BitMask,
  184.     small4BitData                = kSmall4BitData,
  185.     small8BitData                = kSmall8BitData,
  186.     mini1BitMask                = kMini1BitMask,
  187.     mini4BitData                = kMini4BitData,
  188.     mini8BitData                = kMini8BitData
  189. };
  190.  
  191. /* Alignment type values. */
  192.  
  193. enum {
  194.     kAlignNone                    = 0x00,
  195.     kAlignVerticalCenter        = 0x01,
  196.     kAlignTop                    = 0x02,
  197.     kAlignBottom                = 0x03,
  198.     kAlignHorizontalCenter        = 0x04,
  199.     kAlignAbsoluteCenter        = kAlignVerticalCenter | kAlignHorizontalCenter,
  200.     kAlignCenterTop                = kAlignTop | kAlignHorizontalCenter,
  201.     kAlignCenterBottom            = kAlignBottom | kAlignHorizontalCenter,
  202.     kAlignLeft                    = 0x08,
  203.     kAlignCenterLeft            = kAlignVerticalCenter | kAlignLeft,
  204.     kAlignTopLeft                = kAlignTop | kAlignLeft,
  205.     kAlignBottomLeft            = kAlignBottom | kAlignLeft,
  206.     kAlignRight                    = 0x0C,
  207.     kAlignCenterRight            = kAlignVerticalCenter | kAlignRight,
  208.     kAlignTopRight                = kAlignTop | kAlignRight,
  209.     kAlignBottomRight            = kAlignBottom | kAlignRight
  210. };
  211.  
  212. /* Obsolete. Use names defined above. */
  213.  
  214. enum {
  215.     atNone                        = kAlignNone,
  216.     atVerticalCenter            = kAlignVerticalCenter,
  217.     atTop                        = kAlignTop,
  218.     atBottom                    = kAlignBottom,
  219.     atHorizontalCenter            = kAlignHorizontalCenter,
  220.     atAbsoluteCenter            = kAlignAbsoluteCenter,
  221.     atCenterTop                    = kAlignCenterTop,
  222.     atCenterBottom                = kAlignCenterBottom,
  223.     atLeft                        = kAlignLeft,
  224.     atCenterLeft                = kAlignCenterLeft,
  225.     atTopLeft                    = kAlignTopLeft,
  226.     atBottomLeft                = kAlignBottomLeft,
  227.     atRight                        = kAlignRight,
  228.     atCenterRight                = kAlignCenterRight,
  229.     atTopRight                    = kAlignTopRight,
  230.     atBottomRight                = kAlignBottomRight
  231. };
  232.  
  233. typedef SInt16                             IconAlignmentType;
  234. /* Transform type values. */
  235.  
  236. enum {
  237.     kTransformNone                = 0x00,
  238.     kTransformDisabled            = 0x01,
  239.     kTransformOffline            = 0x02,
  240.     kTransformOpen                = 0x03,
  241.     kTransformLabel1            = 0x0100,
  242.     kTransformLabel2            = 0x0200,
  243.     kTransformLabel3            = 0x0300,
  244.     kTransformLabel4            = 0x0400,
  245.     kTransformLabel5            = 0x0500,
  246.     kTransformLabel6            = 0x0600,
  247.     kTransformLabel7            = 0x0700,
  248.     kTransformSelected            = 0x4000,
  249.     kTransformSelectedDisabled    = kTransformSelected | kTransformDisabled,
  250.     kTransformSelectedOffline    = kTransformSelected | kTransformOffline,
  251.     kTransformSelectedOpen        = kTransformSelected | kTransformOpen
  252. };
  253.  
  254. /* Obsolete. Use names defined above. */
  255.  
  256. enum {
  257.     ttNone                        = kTransformNone,
  258.     ttDisabled                    = kTransformDisabled,
  259.     ttOffline                    = kTransformOffline,
  260.     ttOpen                        = kTransformOpen,
  261.     ttLabel1                    = kTransformLabel1,
  262.     ttLabel2                    = kTransformLabel2,
  263.     ttLabel3                    = kTransformLabel3,
  264.     ttLabel4                    = kTransformLabel4,
  265.     ttLabel5                    = kTransformLabel5,
  266.     ttLabel6                    = kTransformLabel6,
  267.     ttLabel7                    = kTransformLabel7,
  268.     ttSelected                    = kTransformSelected,
  269.     ttSelectedDisabled            = kTransformSelectedDisabled,
  270.     ttSelectedOffline            = kTransformSelectedOffline,
  271.     ttSelectedOpen                = kTransformSelectedOpen
  272. };
  273.  
  274. typedef SInt16                             IconTransformType;
  275. /* Selector mask values. */
  276.  
  277. enum {
  278.     kSelectorLarge1Bit            = 0x00000001,
  279.     kSelectorLarge4Bit            = 0x00000002,
  280.     kSelectorLarge8Bit            = 0x00000004,
  281.     kSelectorLarge32Bit            = 0x00000008,
  282.     kSelectorLarge8BitMask        = 0x00000010,
  283.     kSelectorSmall1Bit            = 0x00000100,
  284.     kSelectorSmall4Bit            = 0x00000200,
  285.     kSelectorSmall8Bit            = 0x00000400,
  286.     kSelectorSmall32Bit            = 0x00000800,
  287.     kSelectorSmall8BitMask        = 0x00001000,
  288.     kSelectorMini1Bit            = 0x00010000,
  289.     kSelectorMini4Bit            = 0x00020000,
  290.     kSelectorMini8Bit            = 0x00040000,
  291.     kSelectorHuge1Bit            = 0x01000000,
  292.     kSelectorHuge4Bit            = 0x02000000,
  293.     kSelectorHuge8Bit            = 0x04000000,
  294.     kSelectorHuge32Bit            = 0x08000000,
  295.     kSelectorHuge8BitMask        = 0x10000000,
  296.     kSelectorAllLargeData        = 0x000000FF,
  297.     kSelectorAllSmallData        = 0x0000FF00,
  298.     kSelectorAllMiniData        = 0x00FF0000,
  299.     kSelectorAllHugeData        = (long)0xFF000000,
  300.     kSelectorAll1BitData        = kSelectorLarge1Bit | kSelectorSmall1Bit | kSelectorMini1Bit | kSelectorHuge1Bit,
  301.     kSelectorAll4BitData        = kSelectorLarge4Bit | kSelectorSmall4Bit | kSelectorMini4Bit | kSelectorHuge4Bit,
  302.     kSelectorAll8BitData        = kSelectorLarge8Bit | kSelectorSmall8Bit | kSelectorMini8Bit | kSelectorHuge8Bit,
  303.     kSelectorAll32BitData        = kSelectorLarge32Bit | kSelectorSmall32Bit | kSelectorHuge32Bit,
  304.     kSelectorAllAvailableData    = (long)0xFFFFFFFF
  305. };
  306.  
  307.  
  308. /* Obsolete. Use names defined above. */
  309.  
  310. enum {
  311.     svLarge1Bit                    = kSelectorLarge1Bit,
  312.     svLarge4Bit                    = kSelectorLarge4Bit,
  313.     svLarge8Bit                    = kSelectorLarge8Bit,
  314.     svSmall1Bit                    = kSelectorSmall1Bit,
  315.     svSmall4Bit                    = kSelectorSmall4Bit,
  316.     svSmall8Bit                    = kSelectorSmall8Bit,
  317.     svMini1Bit                    = kSelectorMini1Bit,
  318.     svMini4Bit                    = kSelectorMini4Bit,
  319.     svMini8Bit                    = kSelectorMini8Bit,
  320.     svAllLargeData                = kSelectorAllLargeData,
  321.     svAllSmallData                = kSelectorAllSmallData,
  322.     svAllMiniData                = kSelectorAllMiniData,
  323.     svAll1BitData                = kSelectorAll1BitData,
  324.     svAll4BitData                = kSelectorAll4BitData,
  325.     svAll8BitData                = kSelectorAll8BitData,
  326.     svAllAvailableData            = kSelectorAllAvailableData
  327. };
  328.  
  329. typedef UInt32                             IconSelectorValue;
  330. typedef CALLBACK_API( OSErr , IconActionProcPtr )(ResType theType, Handle *theIcon, void *yourDataPtr);
  331. typedef STACK_UPP_TYPE(IconActionProcPtr)                         IconActionUPP;
  332. enum { uppIconActionProcInfo = 0x00000FE0 };                     /* pascal 2_bytes Func(4_bytes, 4_bytes, 4_bytes) */
  333. #define NewIconActionProc(userRoutine)                             (IconActionUPP)NewRoutineDescriptor((ProcPtr)(userRoutine), uppIconActionProcInfo, GetCurrentArchitecture())
  334. #define CallIconActionProc(userRoutine, theType, theIcon, yourDataPtr)  CALL_THREE_PARAMETER_UPP((userRoutine), uppIconActionProcInfo, (theType), (theIcon), (yourDataPtr))
  335. typedef IconActionProcPtr                 IconAction;
  336. typedef CALLBACK_API( Handle , IconGetterProcPtr )(ResType theType, void *yourDataPtr);
  337. typedef STACK_UPP_TYPE(IconGetterProcPtr)                         IconGetterUPP;
  338. enum { uppIconGetterProcInfo = 0x000003F0 };                     /* pascal 4_bytes Func(4_bytes, 4_bytes) */
  339. #define NewIconGetterProc(userRoutine)                             (IconGetterUPP)NewRoutineDescriptor((ProcPtr)(userRoutine), uppIconGetterProcInfo, GetCurrentArchitecture())
  340. #define CallIconGetterProc(userRoutine, theType, yourDataPtr)     CALL_TWO_PARAMETER_UPP((userRoutine), uppIconGetterProcInfo, (theType), (yourDataPtr))
  341. typedef IconGetterProcPtr                 IconGetter;
  342. #if !OLDROUTINELOCATIONS
  343.  
  344. struct CIcon {
  345.     PixMap                             iconPMap;                    /*the icon's pixMap*/
  346.     BitMap                             iconMask;                    /*the icon's mask*/
  347.     BitMap                             iconBMap;                    /*the icon's bitMap*/
  348.     Handle                             iconData;                    /*the icon's data*/
  349.     SInt16                             iconMaskData[1];            /*icon's mask and BitMap data*/
  350. };
  351. typedef struct CIcon                    CIcon;
  352. typedef CIcon *                            CIconPtr;
  353. typedef CIconPtr *                        CIconHandle;
  354. EXTERN_API( CIconHandle )
  355. GetCIcon                        (SInt16                 iconID)                                ONEWORDINLINE(0xAA1E);
  356.  
  357. EXTERN_API( void )
  358. PlotCIcon                        (const Rect *            theRect,
  359.                                  CIconHandle             theIcon)                            ONEWORDINLINE(0xAA1F);
  360.  
  361. EXTERN_API( void )
  362. DisposeCIcon                    (CIconHandle             theIcon)                            ONEWORDINLINE(0xAA25);
  363.  
  364. #endif  /* !OLDROUTINELOCATIONS */
  365.  
  366. EXTERN_API( Handle )
  367. GetIcon                            (SInt16                 iconID)                                ONEWORDINLINE(0xA9BB);
  368.  
  369. EXTERN_API( void )
  370. PlotIcon                        (const Rect *            theRect,
  371.                                  Handle                 theIcon)                            ONEWORDINLINE(0xA94B);
  372.  
  373.  
  374.  
  375. /*
  376.     Note:    IconSuiteRef and IconCacheRef should be an abstract types, 
  377.             but too much source code already relies on them being of type Handle.
  378. */
  379.  
  380. typedef Handle                             IconSuiteRef;
  381. typedef Handle                             IconCacheRef;
  382. /* IconRefs are 32-bit values identifying cached icon data. IconRef 0 is invalid.*/
  383. typedef struct OpaqueIconRef*             IconRef;
  384. EXTERN_API( OSErr )
  385. PlotIconID                        (const Rect *            theRect,
  386.                                  IconAlignmentType         align,
  387.                                  IconTransformType         transform,
  388.                                  SInt16                 theResID)                            THREEWORDINLINE(0x303C, 0x0500, 0xABC9);
  389.  
  390. EXTERN_API( OSErr )
  391. NewIconSuite                    (IconSuiteRef *            theIconSuite)                        THREEWORDINLINE(0x303C, 0x0207, 0xABC9);
  392.  
  393. EXTERN_API( OSErr )
  394. AddIconToSuite                    (Handle                 theIconData,
  395.                                  IconSuiteRef             theSuite,
  396.                                  ResType                 theType)                            THREEWORDINLINE(0x303C, 0x0608, 0xABC9);
  397.  
  398. EXTERN_API( OSErr )
  399. GetIconFromSuite                (Handle *                theIconData,
  400.                                  IconSuiteRef             theSuite,
  401.                                  ResType                 theType)                            THREEWORDINLINE(0x303C, 0x0609, 0xABC9);
  402.  
  403. EXTERN_API( OSErr )
  404. ForEachIconDo                    (IconSuiteRef             theSuite,
  405.                                  IconSelectorValue         selector,
  406.                                  IconActionUPP             action,
  407.                                  void *                    yourDataPtr)                        THREEWORDINLINE(0x303C, 0x080A, 0xABC9);
  408.  
  409. EXTERN_API( OSErr )
  410. GetIconSuite                    (IconSuiteRef *            theIconSuite,
  411.                                  SInt16                 theResID,
  412.                                  IconSelectorValue         selector)                            THREEWORDINLINE(0x303C, 0x0501, 0xABC9);
  413.  
  414. EXTERN_API( OSErr )
  415. DisposeIconSuite                (IconSuiteRef             theIconSuite,
  416.                                  Boolean                 disposeData)                        THREEWORDINLINE(0x303C, 0x0302, 0xABC9);
  417.  
  418. EXTERN_API( OSErr )
  419. PlotIconSuite                    (const Rect *            theRect,
  420.                                  IconAlignmentType         align,
  421.                                  IconTransformType         transform,
  422.                                  IconSuiteRef             theIconSuite)                        THREEWORDINLINE(0x303C, 0x0603, 0xABC9);
  423.  
  424. EXTERN_API( OSErr )
  425. MakeIconCache                    (IconCacheRef *            theCache,
  426.                                  IconGetterUPP             makeIcon,
  427.                                  void *                    yourDataPtr)                        THREEWORDINLINE(0x303C, 0x0604, 0xABC9);
  428.  
  429. EXTERN_API( OSErr )
  430. LoadIconCache                    (const Rect *            theRect,
  431.                                  IconAlignmentType         align,
  432.                                  IconTransformType         transform,
  433.                                  IconCacheRef             theIconCache)                        THREEWORDINLINE(0x303C, 0x0606, 0xABC9);
  434.  
  435. EXTERN_API( OSErr )
  436. PlotIconMethod                    (const Rect *            theRect,
  437.                                  IconAlignmentType         align,
  438.                                  IconTransformType         transform,
  439.                                  IconGetterUPP             theMethod,
  440.                                  void *                    yourDataPtr)                        THREEWORDINLINE(0x303C, 0x0805, 0xABC9);
  441.  
  442. EXTERN_API( OSErr )
  443. GetLabel                        (SInt16                 labelNumber,
  444.                                  RGBColor *                labelColor,
  445.                                  Str255                 labelString)                        THREEWORDINLINE(0x303C, 0x050B, 0xABC9);
  446.  
  447. EXTERN_API( Boolean )
  448. PtInIconID                        (Point                     testPt,
  449.                                  const Rect *            iconRect,
  450.                                  IconAlignmentType         align,
  451.                                  SInt16                 iconID)                                THREEWORDINLINE(0x303C, 0x060D, 0xABC9);
  452.  
  453. EXTERN_API( Boolean )
  454. PtInIconSuite                    (Point                     testPt,
  455.                                  const Rect *            iconRect,
  456.                                  IconAlignmentType         align,
  457.                                  IconSuiteRef             theIconSuite)                        THREEWORDINLINE(0x303C, 0x070E, 0xABC9);
  458.  
  459. EXTERN_API( Boolean )
  460. PtInIconMethod                    (Point                     testPt,
  461.                                  const Rect *            iconRect,
  462.                                  IconAlignmentType         align,
  463.                                  IconGetterUPP             theMethod,
  464.                                  void *                    yourDataPtr)                        THREEWORDINLINE(0x303C, 0x090F, 0xABC9);
  465.  
  466. EXTERN_API( Boolean )
  467. RectInIconID                    (const Rect *            testRect,
  468.                                  const Rect *            iconRect,
  469.                                  IconAlignmentType         align,
  470.                                  SInt16                 iconID)                                THREEWORDINLINE(0x303C, 0x0610, 0xABC9);
  471.  
  472. EXTERN_API( Boolean )
  473. RectInIconSuite                    (const Rect *            testRect,
  474.                                  const Rect *            iconRect,
  475.                                  IconAlignmentType         align,
  476.                                  IconSuiteRef             theIconSuite)                        THREEWORDINLINE(0x303C, 0x0711, 0xABC9);
  477.  
  478. EXTERN_API( Boolean )
  479. RectInIconMethod                (const Rect *            testRect,
  480.                                  const Rect *            iconRect,
  481.                                  IconAlignmentType         align,
  482.                                  IconGetterUPP             theMethod,
  483.                                  void *                    yourDataPtr)                        THREEWORDINLINE(0x303C, 0x0912, 0xABC9);
  484.  
  485. EXTERN_API( OSErr )
  486. IconIDToRgn                        (RgnHandle                 theRgn,
  487.                                  const Rect *            iconRect,
  488.                                  IconAlignmentType         align,
  489.                                  SInt16                 iconID)                                THREEWORDINLINE(0x303C, 0x0613, 0xABC9);
  490.  
  491. EXTERN_API( OSErr )
  492. IconSuiteToRgn                    (RgnHandle                 theRgn,
  493.                                  const Rect *            iconRect,
  494.                                  IconAlignmentType         align,
  495.                                  IconSuiteRef             theIconSuite)                        THREEWORDINLINE(0x303C, 0x0714, 0xABC9);
  496.  
  497. EXTERN_API( OSErr )
  498. IconMethodToRgn                    (RgnHandle                 theRgn,
  499.                                  const Rect *            iconRect,
  500.                                  IconAlignmentType         align,
  501.                                  IconGetterUPP             theMethod,
  502.                                  void *                    yourDataPtr)                        THREEWORDINLINE(0x303C, 0x0915, 0xABC9);
  503.  
  504. EXTERN_API( OSErr )
  505. SetSuiteLabel                    (IconSuiteRef             theSuite,
  506.                                  SInt16                 theLabel)                            THREEWORDINLINE(0x303C, 0x0316, 0xABC9);
  507.  
  508. EXTERN_API( SInt16 )
  509. GetSuiteLabel                    (IconSuiteRef             theSuite)                            THREEWORDINLINE(0x303C, 0x0217, 0xABC9);
  510.  
  511. EXTERN_API( OSErr )
  512. GetIconCacheData                (IconCacheRef             theCache,
  513.                                  void **                theData)                            THREEWORDINLINE(0x303C, 0x0419, 0xABC9);
  514.  
  515. EXTERN_API( OSErr )
  516. SetIconCacheData                (IconCacheRef             theCache,
  517.                                  void *                    theData)                            THREEWORDINLINE(0x303C, 0x041A, 0xABC9);
  518.  
  519. EXTERN_API( OSErr )
  520. GetIconCacheProc                (IconCacheRef             theCache,
  521.                                  IconGetterUPP *        theProc)                            THREEWORDINLINE(0x303C, 0x041B, 0xABC9);
  522.  
  523. EXTERN_API( OSErr )
  524. SetIconCacheProc                (IconCacheRef             theCache,
  525.                                  IconGetterUPP             theProc)                            THREEWORDINLINE(0x303C, 0x041C, 0xABC9);
  526.  
  527. EXTERN_API( OSErr )
  528. PlotIconHandle                    (const Rect *            theRect,
  529.                                  IconAlignmentType         align,
  530.                                  IconTransformType         transform,
  531.                                  Handle                 theIcon)                            THREEWORDINLINE(0x303C, 0x061D, 0xABC9);
  532.  
  533. EXTERN_API( OSErr )
  534. PlotSICNHandle                    (const Rect *            theRect,
  535.                                  IconAlignmentType         align,
  536.                                  IconTransformType         transform,
  537.                                  Handle                 theSICN)                            THREEWORDINLINE(0x303C, 0x061E, 0xABC9);
  538.  
  539. EXTERN_API( OSErr )
  540. PlotCIconHandle                    (const Rect *            theRect,
  541.                                  IconAlignmentType         align,
  542.                                  IconTransformType         transform,
  543.                                  CIconHandle             theCIcon)                            THREEWORDINLINE(0x303C, 0x061F, 0xABC9);
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555. /*
  556.    IconServices is an efficient mechanism to share icon data amongst multiple 
  557.    clients. It avoids duplication of data; it provides efficient caching, 
  558.    releasing memory when the icon data is no longer needed; it can provide
  559.    the appropriate icon for any filesystem object; it can provide commonly 
  560.    used icons (caution, note, help...); it is Appearance-savvy: the icons
  561.    are switched when appropriate.
  562.    To refer to a cached icon data, IconServices uses IconRef, a 32-bit
  563.    opaque value. IconRefs are reference counted. When there are no more clients 
  564.    for an IconRef, the bitmap memory associated with it is marked as disposeable. 
  565.    Two files of same type and creator with no custom icon will have the same IconRef.
  566.    Files with custom icons will have their own IconRef.
  567. */
  568.  
  569. /*
  570.    Use the special creator kSystemIconsCreator to get "standard" icons 
  571.    that are not associated with a file, such as the help icon.
  572. */
  573.  
  574. enum {
  575.     kSystemIconsCreator            = FOUR_CHAR_CODE('macs')
  576. };
  577.  
  578.  
  579. /*
  580.    Type of the predefined/generic icons. For example, the call:
  581.    GetIconRef(kOnSystemDisk, kSystemIconsCreator, kHelpIcon, &iconRef);
  582.    will retun in iconRef the IconRef for the standard help icon.
  583. */
  584.  
  585. /* Generic Finder icons */
  586.  
  587. enum {
  588.     kClipboardIcon                = FOUR_CHAR_CODE('CLIP'),
  589.     kClippingUnknownTypeIcon    = FOUR_CHAR_CODE('clpu'),
  590.     kClippingPictureTypeIcon    = FOUR_CHAR_CODE('clpp'),
  591.     kClippingTextTypeIcon        = FOUR_CHAR_CODE('clpt'),
  592.     kClippingSoundTypeIcon        = FOUR_CHAR_CODE('clps'),
  593.     kDesktopIcon                = FOUR_CHAR_CODE('desk'),
  594.     kFinderIcon                    = FOUR_CHAR_CODE('FNDR'),
  595.     kFontSuitcaseIcon            = FOUR_CHAR_CODE('FFIL'),
  596.     kFullTrashIcon                = FOUR_CHAR_CODE('ftrh'),
  597.     kGenericApplicationIcon        = FOUR_CHAR_CODE('APPL'),
  598.     kGenericCDROMIcon            = FOUR_CHAR_CODE('cddr'),
  599.     kGenericControlPanelIcon    = FOUR_CHAR_CODE('APPC'),
  600.     kGenericControlStripModuleIcon = FOUR_CHAR_CODE('sdev'),
  601.     kGenericComponentIcon        = FOUR_CHAR_CODE('thng'),
  602.     kGenericDeskAccessoryIcon    = FOUR_CHAR_CODE('APPD'),
  603.     kGenericDocumentIcon        = FOUR_CHAR_CODE('docu'),
  604.     kGenericEditionFileIcon        = FOUR_CHAR_CODE('edtf'),
  605.     kGenericExtensionIcon        = FOUR_CHAR_CODE('INIT'),
  606.     kGenericFileServerIcon        = FOUR_CHAR_CODE('srvr'),
  607.     kGenericFontIcon            = FOUR_CHAR_CODE('ffil'),
  608.     kGenericFontScalerIcon        = FOUR_CHAR_CODE('sclr'),
  609.     kGenericFloppyIcon            = FOUR_CHAR_CODE('flpy'),
  610.     kGenericHardDiskIcon        = FOUR_CHAR_CODE('hdsk'),
  611.     kGenericRemovableMediaIcon    = FOUR_CHAR_CODE('rmov'),
  612.     kGenericMoverObjectIcon        = FOUR_CHAR_CODE('movr'),
  613.     kGenericPCCardIcon            = FOUR_CHAR_CODE('pcmc'),
  614.     kGenericPreferencesIcon        = FOUR_CHAR_CODE('pref'),
  615.     kGenericQueryDocumentIcon    = FOUR_CHAR_CODE('qery'),
  616.     kGenericRAMDiskIcon            = FOUR_CHAR_CODE('ramd'),
  617.     kGenericSharedLibaryIcon    = FOUR_CHAR_CODE('shlb'),
  618.     kGenericStationeryIcon        = FOUR_CHAR_CODE('sdoc'),
  619.     kGenericSuitcaseIcon        = FOUR_CHAR_CODE('suit'),
  620.     kGenericWORMIcon            = FOUR_CHAR_CODE('worm'),
  621.     kInternationResourcesIcon    = FOUR_CHAR_CODE('ifil'),
  622.     kKeyboardLayoutIcon            = FOUR_CHAR_CODE('kfil'),
  623.     kSoundFileIcon                = FOUR_CHAR_CODE('sfil'),
  624.     kSystemSuitcaseIcon            = FOUR_CHAR_CODE('zsys'),
  625.     kTrashIcon                    = FOUR_CHAR_CODE('trsh'),
  626.     kTrueTypeFontIcon            = FOUR_CHAR_CODE('tfil'),
  627.     kTrueTypeFlatFontIcon        = FOUR_CHAR_CODE('sfnt'),
  628.     kTrueTypeMultiFlatFontIcon    = FOUR_CHAR_CODE('ttcf')
  629. };
  630.  
  631. /* Internet locations */
  632.  
  633. enum {
  634.     kInternetLocationHTTPIcon    = FOUR_CHAR_CODE('ilht'),
  635.     kInternetLocationFTPIcon    = FOUR_CHAR_CODE('ilft'),
  636.     kInternetLocationAppleShareIcon = FOUR_CHAR_CODE('ilaf'),
  637.     kInternetLocationAppleTalkZoneIcon = FOUR_CHAR_CODE('ilat'),
  638.     kInternetLocationFileIcon    = FOUR_CHAR_CODE('ilfi'),
  639.     kInternetLocationMailIcon    = FOUR_CHAR_CODE('ilma'),
  640.     kInternetLocationNewsIcon    = FOUR_CHAR_CODE('ilnw'),
  641.     kInternetLocationGenericIcon = FOUR_CHAR_CODE('ilge')
  642. };
  643.  
  644. /* Folders */
  645.  
  646. enum {
  647.     kGenericFolderIcon            = FOUR_CHAR_CODE('fldr'),
  648.     kDropFolderIcon                = FOUR_CHAR_CODE('dbox'),
  649.     kMountedFolderIcon            = FOUR_CHAR_CODE('mntd'),
  650.     kOpenFolderIcon                = FOUR_CHAR_CODE('ofld'),
  651.     kOwnedFolderIcon            = FOUR_CHAR_CODE('ownd'),
  652.     kPrivateFolderIcon            = FOUR_CHAR_CODE('prvf'),
  653.     kSharedFolderIcon            = FOUR_CHAR_CODE('shfl')
  654. };
  655.  
  656. /* Sharing Privileges icons */
  657.  
  658. enum {
  659.     kSharingPrivsNotApplicableIcon = FOUR_CHAR_CODE('shna'),
  660.     kSharingPrivsReadOnlyIcon    = FOUR_CHAR_CODE('shro'),
  661.     kSharingPrivsReadWriteIcon    = FOUR_CHAR_CODE('shrw'),
  662.     kSharingPrivsUnknownIcon    = FOUR_CHAR_CODE('shuk'),
  663.     kSharingPrivsWritableIcon    = FOUR_CHAR_CODE('writ')
  664. };
  665.  
  666.  
  667. /* Users and Groups icons */
  668.  
  669. enum {
  670.     kUserFolderIcon                = FOUR_CHAR_CODE('ufld'),
  671.     kWorkgroupFolderIcon        = FOUR_CHAR_CODE('wfld'),
  672.     kGuestUserIcon                = FOUR_CHAR_CODE('gusr'),
  673.     kUserIcon                    = FOUR_CHAR_CODE('user'),
  674.     kOwnerIcon                    = FOUR_CHAR_CODE('susr'),
  675.     kGroupIcon                    = FOUR_CHAR_CODE('grup')
  676. };
  677.  
  678. /* Special folders */
  679.  
  680. enum {
  681.     kAppleExtrasFolderIcon        = FOUR_CHAR_CODE('aexƒ'),
  682.     kAppleMenuFolderIcon        = FOUR_CHAR_CODE('amnu'),
  683.     kApplicationsFolderIcon        = FOUR_CHAR_CODE('apps'),
  684.     kApplicationSupportFolderIcon = FOUR_CHAR_CODE('asup'),
  685.     kAssistantsFolderIcon        = FOUR_CHAR_CODE('astƒ'),
  686.     kContextualMenuItemsFolderIcon = FOUR_CHAR_CODE('cmnu'),
  687.     kControlPanelDisabledFolderIcon = FOUR_CHAR_CODE('ctrD'),
  688.     kControlPanelFolderIcon        = FOUR_CHAR_CODE('ctrl'),
  689.     kControlStripModulesFolderIcon = FOUR_CHAR_CODE('sdvƒ'),
  690.     kDocumentsFolderIcon        = FOUR_CHAR_CODE('docs'),
  691.     kExtensionsDisabledFolderIcon = FOUR_CHAR_CODE('extD'),
  692.     kExtensionsFolderIcon        = FOUR_CHAR_CODE('extn'),
  693.     kFavoritesFolderIcon        = FOUR_CHAR_CODE('favs'),
  694.     kFontsFolderIcon            = FOUR_CHAR_CODE('font'),
  695.     kHelpFolderIcon                = FOUR_CHAR_CODE('ƒhlp'),
  696.     kInternetFolderIcon            = FOUR_CHAR_CODE('intƒ'),
  697.     kInternetPlugInFolderIcon    = FOUR_CHAR_CODE('ƒnet'),
  698.     kMacOSReadMeFolderIcon        = FOUR_CHAR_CODE('morƒ'),
  699.     kPreferencesFolderIcon        = FOUR_CHAR_CODE('prfƒ'),
  700.     kPrinterDescriptionFolderIcon = FOUR_CHAR_CODE('ppdf'),
  701.     kPrinterDriverFolderIcon    = FOUR_CHAR_CODE('ƒprd'),
  702.     kPrintMonitorFolderIcon        = FOUR_CHAR_CODE('prnt'),
  703.     kRecentApplicationsFolderIcon = FOUR_CHAR_CODE('rapp'),
  704.     kRecentDocumentsFolderIcon    = FOUR_CHAR_CODE('rdoc'),
  705.     kRecentServersFolderIcon    = FOUR_CHAR_CODE('rsrv'),
  706.     kScriptingAdditionsFolderIcon = FOUR_CHAR_CODE('ƒscr'),
  707.     kSharedLibrariesFolderIcon    = FOUR_CHAR_CODE('ƒlib'),
  708.     kScriptsFolderIcon            = FOUR_CHAR_CODE('scrƒ'),
  709.     kShutdownItemsDisabledFolderIcon = FOUR_CHAR_CODE('shdD'),
  710.     kShutdownItemsFolderIcon    = FOUR_CHAR_CODE('shdf'),
  711.     kSpeakableItemsFolder        = FOUR_CHAR_CODE('spki'),
  712.     kStartupItemsDisabledFolderIcon = FOUR_CHAR_CODE('strD'),
  713.     kStartupItemsFolderIcon        = FOUR_CHAR_CODE('strt'),
  714.     kSystemExtensionDisabledFolderIcon = FOUR_CHAR_CODE('macD'),
  715.     kSystemFolderIcon            = FOUR_CHAR_CODE('macs'),
  716.     kTextEncodingsFolderIcon    = FOUR_CHAR_CODE('ƒtex'),
  717.     kAppearanceFolderIcon        = FOUR_CHAR_CODE('appr'),
  718.     kUtilitiesFolderIcon        = FOUR_CHAR_CODE('utiƒ'),
  719.     kVoicesFolderIcon            = FOUR_CHAR_CODE('fvoc'),
  720.     kColorSyncFolderIcon        = FOUR_CHAR_CODE('prof'),
  721.     kInternetSearchSitesFolderIcon = FOUR_CHAR_CODE('issf')
  722. };
  723.  
  724. /* Badges */
  725.  
  726. enum {
  727.     kAppleScriptBadgeIcon        = FOUR_CHAR_CODE('scrp'),
  728.     kLockedBadgeIcon            = FOUR_CHAR_CODE('lbdg'),
  729.     kMountedBadgeIcon            = FOUR_CHAR_CODE('mbdg'),
  730.     kSharedBadgeIcon            = FOUR_CHAR_CODE('sbdg'),
  731.     kAliasBadgeIcon                = FOUR_CHAR_CODE('abdg')
  732. };
  733.  
  734. /* Alert icons */
  735.  
  736. enum {
  737.     kAlertNoteIcon                = FOUR_CHAR_CODE('note'),
  738.     kAlertCautionIcon            = FOUR_CHAR_CODE('caut'),
  739.     kAlertStopIcon                = FOUR_CHAR_CODE('stop')
  740. };
  741.  
  742. /* Networking icons */
  743.  
  744. enum {
  745.     kAppleTalkIcon                = FOUR_CHAR_CODE('atlk'),
  746.     kAppleTalkZoneIcon            = FOUR_CHAR_CODE('atzn'),
  747.     kAFPServerIcon                = FOUR_CHAR_CODE('afps'),
  748.     kFTPServerIcon                = FOUR_CHAR_CODE('ftps'),
  749.     kIPFileServerIcon            = FOUR_CHAR_CODE('isrv')
  750. };
  751.  
  752. /* Other icons */
  753.  
  754. enum {
  755.     kAppleLogoIcon                = FOUR_CHAR_CODE('capl'),
  756.     kAppleMenuIcon                = FOUR_CHAR_CODE('sapl'),
  757.     kBackwardArrowIcon            = FOUR_CHAR_CODE('baro'),
  758.     kFavoriteItemsIcon            = FOUR_CHAR_CODE('favr'),
  759.     kForwardArrowIcon            = FOUR_CHAR_CODE('faro'),
  760.     kGridIcon                    = FOUR_CHAR_CODE('grid'),
  761.     kHelpIcon                    = FOUR_CHAR_CODE('help'),
  762.     kKeepArrangedIcon            = FOUR_CHAR_CODE('arng'),
  763.     kLockedIcon                    = FOUR_CHAR_CODE('lock'),
  764.     kNoFilesIcon                = FOUR_CHAR_CODE('nfil'),
  765.     kNoFolderIcon                = FOUR_CHAR_CODE('nfld'),
  766.     kNoWriteIcon                = FOUR_CHAR_CODE('nwrt'),
  767.     kProtectedApplicationFolderIcon = FOUR_CHAR_CODE('papp'),
  768.     kProtectedSystemFolderIcon    = FOUR_CHAR_CODE('psys'),
  769.     kRecentItemsIcon            = FOUR_CHAR_CODE('rcnt'),
  770.     kShortcutIcon                = FOUR_CHAR_CODE('shrt'),
  771.     kSortAscendingIcon            = FOUR_CHAR_CODE('asnd'),
  772.     kSortDescendingIcon            = FOUR_CHAR_CODE('dsnd'),
  773.     kUnlockedIcon                = FOUR_CHAR_CODE('ulck'),
  774.     kConnectToIcon                = FOUR_CHAR_CODE('cnct')
  775. };
  776.  
  777.  
  778. /*    Error codes range from -2580 to -2599 */
  779.  
  780. enum {
  781.     invalidIconRefErr            = -2580,
  782.     noSuchIconErr                = -2581,
  783.     noIconDataAvailableErr        = -2582
  784. };
  785.  
  786.  
  787. /*    IconServicesUsageFlags */
  788. typedef UInt32                             IconServicesUsageFlags;
  789.  
  790. enum {
  791.     kIconServicesNormalUsageFlag = 0
  792. };
  793.  
  794.  
  795. /*
  796.       IconFamily 'icns' resources contain an entire IconFamily (all sizes and depths).  
  797.    For custom icons, icns IconFamily resources of the custom icon resource ID are fetched first before
  798.    the classic custom icons (individual 'ics#, ICN#, etc) are fetched.  If the fetch of the icns resource
  799.    succeeds then the icns is looked at exclusively for the icon data.
  800.    For custom icons, new icon features such as 32-bit deep icons are only fetched from the icns resource.
  801.    This is to avoid incompatibilities with cut & paste of new style icons with an older version of the
  802.    MacOS Finder.
  803.    DriverGestalt is called with code kdgMediaIconSuite by IconServices after calling FSM to determine a
  804.    driver icon for a particular device.  The result of the kdgMediaIconSuite call to DriverGestalt should
  805.    be a pointer an an IconFamily.  In this manner driver vendors can provide rich, detailed drive icons
  806.    instead of the 1-bit variety previously supported.
  807. */
  808.  
  809. enum {
  810.     kIconFamilyType                = FOUR_CHAR_CODE('icns')
  811. };
  812.  
  813.  
  814.  
  815. struct IconFamilyElement {
  816.     OSType                             elementType;                /* 'ICN#', 'icl8', etc...*/
  817.     Size                             elementSize;                /* Size of this element*/
  818.     unsigned char                     elementData[1];
  819. };
  820. typedef struct IconFamilyElement        IconFamilyElement;
  821.  
  822. struct IconFamilyResource {
  823.     OSType                             resourceType;                /* Always 'icns'*/
  824.     Size                             resourceSize;                /* Total size of this resource*/
  825.     IconFamilyElement                 elements[1];
  826.  
  827. };
  828. typedef struct IconFamilyResource        IconFamilyResource;
  829.  
  830. typedef IconFamilyResource *            IconFamilyPtr;
  831. typedef IconFamilyPtr *                    IconFamilyHandle;
  832.  
  833. /*
  834.   ==============================================================================
  835.    Initialization and Termination
  836.   ==============================================================================
  837. */
  838.  
  839.  
  840. /*
  841.    IconServicesInit
  842.    
  843.    Call this routine once per classic 68K application initialization.
  844.    This routine does not need to be called at boot time.
  845. */
  846.  
  847. EXTERN_API( OSErr )
  848. IconServicesInit                (CFragInitBlockPtr         initBlockPtr)                        TWOWORDINLINE(0x7015, 0xAA75);
  849.  
  850.  
  851. /*
  852.    IconServicesTerminate:
  853.    
  854.    Call this routine once from the termination of a classic 68K application.
  855.    This routine does not need to be called at boot time.
  856. */
  857.  
  858. EXTERN_API( void )
  859. IconServicesTerminate            (void)                                                        TWOWORDINLINE(0x7016, 0xAA75);
  860.  
  861.  
  862.  
  863. /*
  864.   ==============================================================================
  865.    Converting data structures
  866.   ==============================================================================
  867. */
  868.  
  869.  
  870. /*
  871.    IconRefToIconFamily
  872.    This routines returns a new IconFamily that contains the data corresponding
  873.    to the specified IconRef
  874. */
  875.  
  876. EXTERN_API( OSErr )
  877. IconRefToIconFamily                (IconRef                 theIconRef,
  878.                                  IconSelectorValue         whichIcons,
  879.                                  IconFamilyHandle *        iconFamily)                            TWOWORDINLINE(0x7024, 0xAA75);
  880.  
  881.  
  882. /*
  883.    IconFamilyToIconSuite
  884.    This routines transfers the data in an icon family into an icon suite.
  885. */
  886.  
  887. EXTERN_API( OSErr )
  888. IconFamilyToIconSuite            (IconFamilyHandle         iconFamily,
  889.                                  IconSelectorValue         whichIcons,
  890.                                  IconSuiteRef *            iconSuite)                            TWOWORDINLINE(0x7025, 0xAA75);
  891.  
  892.  
  893. /*
  894.    IconSuiteToIconFamily
  895.    This routines transfers the data in an icon suite into an icon family.
  896. */
  897.  
  898. EXTERN_API( OSErr )
  899. IconSuiteToIconFamily            (IconSuiteRef             iconSuite,
  900.                                  IconSelectorValue         whichIcons,
  901.                                  IconFamilyHandle *        iconFamily)                            TWOWORDINLINE(0x7026, 0xAA75);
  902.  
  903.  
  904. /*
  905.    SetIconFamilyData
  906.    Change the data of an icon family. The data is copied.
  907.    The type can be one of the icon type, or 'PICT'
  908.    The data will be compressed if needed.
  909. */
  910.  
  911. EXTERN_API( OSErr )
  912. SetIconFamilyData                (IconFamilyHandle         iconFamily,
  913.                                  OSType                 iconType,
  914.                                  Handle                 h)                                    TWOWORDINLINE(0x7030, 0xAA75);
  915.  
  916.  
  917. /*
  918.    GetIconFamilyData
  919.    Return a copy of the data in the icon family.
  920.    The type can be one of the icon type, or 'PICT'
  921.    The data will be returned uncompressed.
  922. */
  923.  
  924. EXTERN_API( OSErr )
  925. GetIconFamilyData                (IconFamilyHandle         iconFamily,
  926.                                  OSType                 iconType,
  927.                                  Handle                 h)                                    TWOWORDINLINE(0x7031, 0xAA75);
  928.  
  929.  
  930. /*
  931.   ==============================================================================
  932.    Reference counting
  933.   ==============================================================================
  934. */
  935.  
  936.  
  937. /*
  938.    GetIconRefOwners
  939.    
  940.    This routine returns the reference count for the IconRef, or number of owners.
  941.    
  942.    A valid IconRef always has at least one owner.
  943. */
  944.  
  945. EXTERN_API( OSErr )
  946. GetIconRefOwners                (IconRef                 theIconRef,
  947.                                  UInt16 *                owners)                                TWOWORDINLINE(0x700B, 0xAA75);
  948.  
  949.  
  950. /*
  951.    AcquireIconRef
  952.    This routine increments the reference count for the IconRef
  953. */
  954.  
  955. EXTERN_API( OSErr )
  956. AcquireIconRef                    (IconRef                 theIconRef)                            TWOWORDINLINE(0x7027, 0xAA75);
  957.  
  958.  
  959.  
  960. /*
  961.    ReleaseIconRef
  962.    
  963.    This routine decrements the reference count for the IconRef.
  964.    
  965.    When the reference count reaches 0, all memory allocated for the icon
  966.    is disposed. Any subsequent use of the IconRef is invalid.
  967. */
  968.  
  969. EXTERN_API( OSErr )
  970. ReleaseIconRef                    (IconRef                 theIconRef)                            TWOWORDINLINE(0x7028, 0xAA75);
  971.  
  972.  
  973.  
  974. /*
  975.   ==============================================================================
  976.    Getting an IconRef
  977.   ==============================================================================
  978. */
  979.  
  980.  
  981. /*
  982.    GetIconRefFromFile
  983.    
  984.    This routine returns an icon ref for the specified file, folder or volume.
  985.    The label information is provided separately, since two files with the same icon 
  986.    but a different label would share the same iconRef. The label can be used in 
  987.    PlotIconRef() for example.
  988.    
  989.    Use this routine if you have no information about the file system object. If 
  990.    you have already done a GetCatInfo on the file and want to save some I/O, 
  991.    call GetIconRefFromFolder() if you know it's a folder with no custom icon or 
  992.    call GetIconRef() if it's a file with no custom icon.
  993.    This routine increments the reference count of the returned IconRef. Call 
  994.    ReleaseIconRef() when you're done with it.
  995. */
  996.  
  997. EXTERN_API( OSErr )
  998. GetIconRefFromFile                (const FSSpec *            theFile,
  999.                                  IconRef *                theIconRef,
  1000.                                  SInt16 *                theLabel)                            TWOWORDINLINE(0x7002, 0xAA75);
  1001.  
  1002.  
  1003.  
  1004. /*
  1005.    GetIconRef
  1006.    
  1007.    This routine returns an icon ref for an icon in the desktop database or
  1008.    for a registered icon.
  1009.    The system registers a set of icon such as the help icon with the creator 
  1010.    code kSystemIconCreator. See above for a list of the registered system types.
  1011.    The vRefNum is used as a hint on where to look for the icon first. Use 
  1012.    kOnSystemDisk if you don't know what to pass.
  1013.    This routine increments the reference count of the returned IconRef. Call 
  1014.    ReleaseIconRef() when you're done with it.
  1015. */
  1016.  
  1017. EXTERN_API( OSErr )
  1018. GetIconRef                        (SInt16                 vRefNum,
  1019.                                  OSType                 creator,
  1020.                                  OSType                 iconType,
  1021.                                  IconRef *                theIconRef)                            TWOWORDINLINE(0x7021, 0xAA75);
  1022.  
  1023.  
  1024.  
  1025. /*
  1026.    GetIconRefFromFolder
  1027.    
  1028.    This routine returns an icon ref for a folder with no custom icon.
  1029.    Use the more generic, but slightly slower, GetIconRefFromFile() if
  1030.    you don't already have the necessary info about the file.
  1031.    Attributes should be CInfoPBRec.dirInfo.ioFlAttrib for this folder.
  1032.    Access privileges should be CInfoPBRec.dirInfo.ioACUser for this folder.
  1033.    This routine increments the reference count of the IconRef. Call ReleaseIconRef() 
  1034.    when you're done with it.
  1035. */
  1036.  
  1037. EXTERN_API( OSErr )
  1038. GetIconRefFromFolder            (SInt16                 vRefNum,
  1039.                                  SInt32                 parentFolderID,
  1040.                                  SInt32                 folderID,
  1041.                                  SInt8                     attributes,
  1042.                                  SInt8                     accessPrivileges,
  1043.                                  IconRef *                theIconRef)                            TWOWORDINLINE(0x7022, 0xAA75);
  1044.  
  1045.  
  1046.  
  1047. /*
  1048.   ==============================================================================
  1049.    Adding and modifying IconRef
  1050.   ==============================================================================
  1051. */
  1052.  
  1053.  
  1054. /*
  1055.    RegisterIconRefFromIconFamily
  1056.    This routine adds a new entry to the IconRef registry. Other clients will be 
  1057.    able to access it using the (creator, iconType) pair specified here.
  1058.    Lower-case creators are reserved for the system.
  1059.    Consider using RegisterIconRefFromResource() if possible, since the data 
  1060.    registered using RegisterIconRefFromFamily() cannot be purged.
  1061.    The iconFamily data is copied and the caller is reponsible for disposing of it.
  1062.    This routine increments the reference count of the IconRef. Call ReleaseIconRef() 
  1063.    when you're done with it.
  1064. */
  1065.  
  1066. EXTERN_API( OSErr )
  1067. RegisterIconRefFromIconFamily    (OSType                 creator,
  1068.                                  OSType                 iconType,
  1069.                                  IconFamilyHandle         iconFamily,
  1070.                                  IconRef *                theIconRef)                            TWOWORDINLINE(0x701C, 0xAA75);
  1071.  
  1072.  
  1073. /*
  1074.    RegisterIconRefFromResource
  1075.    
  1076.    Registers an IconRef from a resouce file.  
  1077.    The icon data to be fetched is either classic icon data or an icon family.  
  1078.    The 'icns' icon family is searched for before the classic icon data.
  1079.    This routine increments the reference count of the IconRef. Call ReleaseIconRef() 
  1080.    when you're done with it.
  1081. */
  1082.  
  1083. EXTERN_API( OSErr )
  1084. RegisterIconRefFromResource        (OSType                 creator,
  1085.                                  OSType                 iconType,
  1086.                                  const FSSpec *            resourceFile,
  1087.                                  SInt16                 resourceID,
  1088.                                  IconRef *                theIconRef)                            TWOWORDINLINE(0x7023, 0xAA75);
  1089.  
  1090.  
  1091. /*
  1092.    UnregisterIconRef
  1093.    
  1094.    Removes the specified icon from the icon cache (if there are no users of it).  
  1095.    If some clients are using this iconRef, then the IconRef will be removed when the 
  1096.    last user calls ReleaseIconRef.
  1097. */
  1098.  
  1099. EXTERN_API( OSErr )
  1100. UnregisterIconRef                (OSType                 creator,
  1101.                                  OSType                 iconType)                            TWOWORDINLINE(0x7008, 0xAA75);
  1102.  
  1103.  
  1104.  
  1105. /*
  1106.    UpdateIconRef
  1107.    
  1108.    Call this routine to force an update of the data for iconRef.
  1109.    
  1110.    For example after changing an icon in the desktop database or changing the custom 
  1111.    icon of a file. Note that after _adding_ a custom icon to file or folder, you 
  1112.    need to call GetIconRefFromFile() to get a new IconRef specific to this file. 
  1113.    
  1114.    This routine does nothing if the IconRef is a registered icon.
  1115. */
  1116.  
  1117. EXTERN_API( OSErr )
  1118. UpdateIconRef                    (IconRef                 theIconRef)                            TWOWORDINLINE(0x7009, 0xAA75);
  1119.  
  1120.  
  1121.  
  1122. /*
  1123.    OverrideIconRefFromResource
  1124.    
  1125.    This routines replaces the bitmaps of the specified IconRef with the ones
  1126.    in the specified resource file.
  1127. */
  1128.  
  1129. EXTERN_API( OSErr )
  1130. OverrideIconRefFromResource        (IconRef                 theIconRef,
  1131.                                  const FSSpec *            resourceFile,
  1132.                                  SInt16                 resourceID)                            TWOWORDINLINE(0x702A, 0xAA75);
  1133.  
  1134.  
  1135.  
  1136. /*
  1137.    OverrideIconRef
  1138.    
  1139.    This routines replaces the bitmaps of the specified IconRef with the ones
  1140.    from the new IconRef.
  1141. */
  1142.  
  1143. EXTERN_API( OSErr )
  1144. OverrideIconRef                    (IconRef                 oldIconRef,
  1145.                                  IconRef                 newIconRef)                            TWOWORDINLINE(0x702B, 0xAA75);
  1146.  
  1147.  
  1148. /*
  1149.    RemoveIconRefOverride
  1150.    This routine remove an override if one was applied to the icon and 
  1151.    reverts back to the original bitmap data.
  1152. */
  1153.  
  1154. EXTERN_API( OSErr )
  1155. RemoveIconRefOverride            (IconRef                 theIconRef)                            TWOWORDINLINE(0x701E, 0xAA75);
  1156.  
  1157.  
  1158.  
  1159. /*
  1160.   ==============================================================================
  1161.    Creating composite IconRef
  1162.   ==============================================================================
  1163. */
  1164.  
  1165.  
  1166. /*
  1167.    CompositeIconRef
  1168.    
  1169.    Superimposes an IconRef on top of another one
  1170. */
  1171.  
  1172. EXTERN_API( OSErr )
  1173. CompositeIconRef                (IconRef                 backgroundIconRef,
  1174.                                  IconRef                 foregroundIconRef,
  1175.                                  IconRef *                compositeIconRef)                    TWOWORDINLINE(0x7014, 0xAA75);
  1176.  
  1177.  
  1178. /*
  1179.    IsIconRefComposite
  1180.    Indicates if a given icon ref is a composite of two other icon refs (and which ones)
  1181.    If it isn't a composite, backgroundIconRef and foreGroundIconRef will be 0.
  1182. */
  1183.  
  1184. EXTERN_API( OSErr )
  1185. IsIconRefComposite                (IconRef                 compositeIconRef,
  1186.                                  IconRef *                backgroundIconRef,
  1187.                                  IconRef *                foregroundIconRef)                    TWOWORDINLINE(0x701A, 0xAA75);
  1188.  
  1189.  
  1190.  
  1191. /*
  1192.   ==============================================================================
  1193.    Using IconRef
  1194.   ==============================================================================
  1195. */
  1196.  
  1197. /*
  1198.    IsValidIconRef
  1199.    Return true if the iconRef passed in is a valid icon ref
  1200. */
  1201.  
  1202. EXTERN_API( Boolean )
  1203. IsValidIconRef                    (IconRef                 theIconRef)                            TWOWORDINLINE(0x7032, 0xAA75);
  1204.  
  1205.  
  1206. /*
  1207.    PlotIconRef
  1208.    
  1209.    This routine plots the IconRef.  It mostly takes the same parameters as PlotIconSuite.
  1210.    Pass kIconServicesNormalUsageFlag as a default value for IconServicesUsageFlags.
  1211. */
  1212.  
  1213. EXTERN_API( OSErr )
  1214. PlotIconRef                        (const Rect *            theRect,
  1215.                                  IconAlignmentType         align,
  1216.                                  IconTransformType         transform,
  1217.                                  IconServicesUsageFlags  theIconServicesUsageFlags,
  1218.                                  IconRef                 theIconRef)                            TWOWORDINLINE(0x700E, 0xAA75);
  1219.  
  1220.  
  1221. /*
  1222.    PtInIconRef
  1223.    
  1224.    This routine indicates if testPt would hit the icon designated by iconRef.
  1225.    It mostly takes the same parameters as PtInIconSuite.
  1226.    Pass kIconServicesNormalUsageFlag as a default value for IconServicesUsageFlags.
  1227. */
  1228.  
  1229.  
  1230. EXTERN_API( Boolean )
  1231. PtInIconRef                        (const Point *            testPt,
  1232.                                  const Rect *            iconRect,
  1233.                                  IconAlignmentType         align,
  1234.                                  IconServicesUsageFlags  theIconServicesUsageFlags,
  1235.                                  IconRef                 theIconRef)                            TWOWORDINLINE(0x700F, 0xAA75);
  1236.  
  1237.  
  1238. /*
  1239.    RectInIconRef
  1240.    
  1241.    This routine indicates if testRect would intersect the icon designated by iconRef.
  1242.    It mostly takes the same parameters as RectInIconSuite.
  1243.    Pass kIconServicesNormalUsageFlag as a default value for IconServicesUsageFlags.
  1244. */
  1245.  
  1246.  
  1247. EXTERN_API( Boolean )
  1248. RectInIconRef                    (const Rect *            testRect,
  1249.                                  const Rect *            iconRect,
  1250.                                  IconAlignmentType         align,
  1251.                                  IconServicesUsageFlags  iconServicesUsageFlags,
  1252.                                  IconRef                 theIconRef)                            TWOWORDINLINE(0x7010, 0xAA75);
  1253.  
  1254.  
  1255. /*
  1256.    IconRefToRgn
  1257.    
  1258.    This routine returns a region for the icon.
  1259.    It mostly takes the same parameters as IconSuiteToRgn.
  1260.    Pass kIconServicesNormalUsageFlag as a default value for IconServicesUsageFlags.
  1261. */
  1262.  
  1263. EXTERN_API( OSErr )
  1264. IconRefToRgn                    (RgnHandle                 theRgn,
  1265.                                  const Rect *            iconRect,
  1266.                                  IconAlignmentType         align,
  1267.                                  IconServicesUsageFlags  iconServicesUsageFlags,
  1268.                                  IconRef                 theIconRef)                            TWOWORDINLINE(0x7011, 0xAA75);
  1269.  
  1270.  
  1271. /*
  1272.    GetIconSizesFromIconRef
  1273.    
  1274.    This routine returns an IconSelectorValue indicating the depths and sizes of 
  1275.    icon data which are actually available.  It takes an IconSelectorValue 
  1276.    indicating which sizes/depths the caller is interested and returns an 
  1277.    IconSelectorValue indicating which sizes/depths exist.
  1278.    
  1279.    Caution:
  1280.    
  1281.    This is potentially an extremely expensive call as IconServices may be forced 
  1282.    to attempt fetching the data for the IconRef's sizes/depths which may result 
  1283.    in hitting the local disk or even the network to obtain the data to determine 
  1284.    which sizes/depths actually exist.
  1285.    Pass kIconServicesNormalUsageFlag as a default value for IconServicesUsageFlags.
  1286. */
  1287.  
  1288. EXTERN_API( OSErr )
  1289. GetIconSizesFromIconRef            (IconSelectorValue         iconSelectorInput,
  1290.                                  IconSelectorValue *    iconSelectorOutputPtr,
  1291.                                  IconServicesUsageFlags  iconServicesUsageFlags,
  1292.                                  IconRef                 theIconRef)                            TWOWORDINLINE(0x7012, 0xAA75);
  1293.  
  1294.  
  1295.  
  1296. /*
  1297.   ==============================================================================
  1298.    Flushing IconRef data
  1299.   ==============================================================================
  1300. */
  1301.  
  1302.  
  1303. /*
  1304.    FlushIconRefs
  1305.    
  1306.    Making this call will dispose of all the data for the specified icons if 
  1307.    the data can be reacquired, for example if the data is provided from a resource.
  1308.    '****' is a wildcard for all types or all creators.
  1309. */
  1310.  
  1311. EXTERN_API( OSErr )
  1312. FlushIconRefs                    (OSType                 creator,
  1313.                                  OSType                 iconType)                            TWOWORDINLINE(0x7029, 0xAA75);
  1314.  
  1315.  
  1316. /*
  1317.    FlushIconRefsByVolume
  1318.    
  1319.    This routine disposes of the data for the icons related to the indicated volume
  1320.    if this data can be reacquired, for example if the data is provided from a 
  1321.    resource.
  1322. */
  1323.  
  1324. EXTERN_API( OSErr )
  1325. FlushIconRefsByVolume            (SInt16                 vRefNum)                            TWOWORDINLINE(0x7018, 0xAA75);
  1326.  
  1327.  
  1328.  
  1329. /*
  1330.   ==============================================================================
  1331.    Controling custom icons
  1332.   ==============================================================================
  1333. */
  1334.  
  1335.  
  1336. /*
  1337.    SetCustomIconsEnabled
  1338.    
  1339.    Enable or disable custom icons on the specified volume.
  1340. */
  1341.  
  1342. EXTERN_API( OSErr )
  1343. SetCustomIconsEnabled            (SInt16                 vRefNum,
  1344.                                  Boolean                 enableCustomIcons)                    TWOWORDINLINE(0x701F, 0xAA75);
  1345.  
  1346.  
  1347. /*
  1348.    GetCustomIconsEnabled
  1349.    
  1350.    Return true if custom icons are enabled on the specified volume, false otherwise.
  1351. */
  1352.  
  1353. EXTERN_API( OSErr )
  1354. GetCustomIconsEnabled            (SInt16                 vRefNum,
  1355.                                  Boolean *                customIconsEnabled)                    TWOWORDINLINE(0x7020, 0xAA75);
  1356.  
  1357.  
  1358.  
  1359.  
  1360. #if PRAGMA_STRUCT_ALIGN
  1361.     #pragma options align=reset
  1362. #elif PRAGMA_STRUCT_PACKPUSH
  1363.     #pragma pack(pop)
  1364. #elif PRAGMA_STRUCT_PACK
  1365.     #pragma pack()
  1366. #endif
  1367.  
  1368. #ifdef PRAGMA_IMPORT_OFF
  1369. #pragma import off
  1370. #elif PRAGMA_IMPORT
  1371. #pragma import reset
  1372. #endif
  1373.  
  1374. #ifdef __cplusplus
  1375. }
  1376. #endif
  1377.  
  1378. #endif /* __ICONS__ */
  1379.  
  1380.